feat(rf): FXC-1604 API for extending structures into pml #3026

George-Guryev-flxcmp · 2025-11-25T08:35:56Z

This PR adds feature for automatic extrusion of structures located next to the simulation boundaries into PML/Absorber. This is facilitated by additional field enable_extrusion in class AbsorberSpec.

Greptile Overview

Greptile Summary

This PR adds an API field enable_extrusion to the AbsorberSpec class, allowing users to enable automatic extrusion of structures into PML/Absorber boundary regions. The field is properly documented and tested.

Key Changes:

Added enable_extrusion boolean field to AbsorberSpec class (inherited by PML, StablePML, and Absorber)
Field defaults to False to maintain backward compatibility
Added comprehensive test coverage verifying the field works only on absorber types
Updated all simulation schemas to reflect the new field
Added clear changelog entry

Important Notes:

This appears to be an API-only addition; the actual implementation logic that uses this field is not present in this PR
The field is stored but not consumed by any simulation or validation logic yet
Similar to the extrude_structures field in WavePort, this likely prepares the groundwork for future implementation

Confidence Score: 4/5

This PR is safe to merge with minimal risk as it only adds an API field without implementation logic
Score of 4 reflects that this is a clean API addition with proper documentation and tests, but the field is not yet used anywhere in the codebase. Minor style improvements suggested for test assertions. The change is backward compatible and follows established patterns.
No files require special attention - all changes are straightforward API additions

Important Files Changed

File Analysis

Filename	Score	Overview
tidy3d/components/boundary.py	5/5	Added `enable_extrusion` boolean field to `AbsorberSpec` class with proper default value and documentation
tests/test_components/test_boundaries.py	4/5	Added test for `enable_extrusion` field checking default values and exclusivity to absorber types; uses direct equality instead of `is` for boolean checks
CHANGELOG.md	5/5	Added clear user-facing changelog entry documenting the new `enable_extrusion` field in `AbsorberSpec`

Sequence Diagram

sequenceDiagram
    participant User
    participant Simulation
    participant BoundarySpec
    participant AbsorberSpec
    participant PML/Absorber
    
    User->>Simulation: Create simulation with boundary conditions
    User->>PML/Absorber: PML(enable_extrusion=True)
    PML/Absorber->>AbsorberSpec: Initialize with enable_extrusion field
    AbsorberSpec->>AbsorberSpec: Store enable_extrusion=True
    AbsorberSpec-->>PML/Absorber: Return configured boundary
    PML/Absorber-->>Simulation: Add to boundary specification
    Simulation->>BoundarySpec: Configure x/y/z boundaries
    
    Note over Simulation,BoundarySpec: Field is stored but not yet used in implementation
    Note over User,PML/Absorber: API surface prepared for future extrusion logic

greptile-apps

_{7 files reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}

tests/test_components/test_boundaries.py

github-actions · 2025-11-25T09:03:55Z

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

tidy3d/components/boundary.py (100%)

Summary

Total: 2 lines
Missing: 0 lines
Coverage: 100%

daquinteroflex · 2025-11-25T14:54:16Z

Are we sure this is not required for rc3? It's a schema change that will be blocked till 2.11. @George-Guryev-flxcmp @dbochkov-flexcompute @weiliangjin2021

weiliangjin2021 · 2025-11-25T16:22:01Z

Are we sure this is not required for rc3? It's a schema change that will be blocked till 2.11. @George-Guryev-flxcmp @dbochkov-flexcompute @weiliangjin2021

If so, let's try to get it in for rc3. When is the deadline for merging PRs for rc3?

tidy3d/components/boundary.py

daquinteroflex · 2025-11-25T19:22:10Z

If so, let's try to get it in for rc3. When is the deadline for merging PRs for rc3?

Can you get this in for tomorrow?

George-Guryev-flxcmp · 2025-11-25T19:27:42Z

If so, let's try to get it in for rc3. When is the deadline for merging PRs for rc3?

Can you get this in for tomorrow?

Sure thing.

tidy3d/components/boundary.py

…ures into pml

dbochkov-flexcompute

Also need to override _structures_not_at_edges

tidy3d/tidy3d/components/base_sim/simulation.py

Lines 160 to 188 in 7db47cf

    
           @pd.validator("structures", always=True) 
        
           @skip_if_fields_missing(["size", "center"]) 
        
           def _structures_not_at_edges(cls, val, values): 
        
               """Warn if any structures lie at the simulation boundaries.""" 
        
               if val is None: 
        
                   return val 
        
               sim_box = Box(size=values.get("size"), center=values.get("center")) 
        
               sim_bound_min, sim_bound_max = sim_box.bounds 
        
               sim_bounds = list(sim_bound_min) + list(sim_bound_max) 
        
               with log as consolidated_logger: 
        
                   for istruct, structure in enumerate(val): 
        
                       struct_bound_min, struct_bound_max = structure.geometry.bounds 
        
                       struct_bounds = list(struct_bound_min) + list(struct_bound_max) 
        
                       for sim_val, struct_val in zip(sim_bounds, struct_bounds): 
        
                           if anp.isclose(sim_val, struct_val): 
        
                               consolidated_logger.warning( 
        
                                   f"Structure at 'structures[{istruct}]' has bounds that extend exactly " 
        
                                   "to simulation edges. This can cause unexpected behavior. " 
        
                                   "If intending to extend the structure to infinity along one dimension, " 
        
                                   "use td.inf as a size variable instead to make this explicit.", 
        
                                   custom_loc=["structures", istruct], 
        
                               ) 
        
                               continue 
        
               return val

with a modified function for Simulation

dbochkov-flexcompute · 2025-12-14T02:12:57Z

tidy3d/components/simulation.py

+                            if boundary[0].extrude_structures:
+                                warn_extruded(structure, istruct, axis + "-min")
+                            else:
+                                warn(structure, istruct, axis + "-min")


what if a structure is less than half wavelength away from pml, but still not close enough to be extruded?

dbochkov-flexcompute · 2025-12-14T02:18:25Z

tidy3d/components/boundary.py

+        False,
+        title="Enable structure extrusion to PML",
+        description="Automatically extrude structures into the absorbing region (e.g., PML or adiabatic absorber)."
+        "Any structure located within `CLIP_OFFSET` of a simulation boundary will be extended through the full thickness of the PML/absorber."


probably better to change within CLIP_OFFSET of to within {CLIP_OFFSET} cells of

dbochkov-flexcompute · 2025-12-14T02:22:55Z

tidy3d/components/simulation.py

                    custom_loc=["structures", istruct],
                )

+            def warn_extruded(structure, istruct, side) -> None:


consider extending the original warn with additional parameter, instead of a new mostly duplicating function

greptile-apps bot reviewed Nov 25, 2025

View reviewed changes

tests/test_components/test_boundaries.py Outdated Show resolved Hide resolved

tests/test_components/test_boundaries.py Outdated Show resolved Hide resolved

George-Guryev-flxcmp force-pushed the george/extrusion_to_pml branch from 89861b7 to 83e10f4 Compare November 25, 2025 08:45

George-Guryev-flxcmp requested review from dbochkov-flexcompute and weiliangjin2021 November 25, 2025 09:11

weiliangjin2021 requested changes Nov 25, 2025

View reviewed changes

tidy3d/components/boundary.py Outdated Show resolved Hide resolved

tidy3d/components/boundary.py Show resolved Hide resolved

George-Guryev-flxcmp force-pushed the george/extrusion_to_pml branch from 83e10f4 to 4969e99 Compare November 25, 2025 18:44

dbochkov-flexcompute reviewed Nov 25, 2025

View reviewed changes

tidy3d/components/boundary.py Outdated Show resolved Hide resolved

tidy3d/components/boundary.py Outdated Show resolved Hide resolved

daquinteroflex added rc3 3rd pre-release 2.10 and removed rc3 3rd pre-release 2.10 labels Nov 26, 2025

George-Guryev-flxcmp force-pushed the george/extrusion_to_pml branch 5 times, most recently from 98c56f5 to a0cba1d Compare December 2, 2025 06:39

George-Guryev-flxcmp force-pushed the george/extrusion_to_pml branch 2 times, most recently from c9522d4 to 222c6fb Compare December 9, 2025 02:02

feat(rf): FXC 1604 add api for automatic extrusion of boundary struct…

c70e7f2

…ures into pml

George-Guryev-flxcmp force-pushed the george/extrusion_to_pml branch from 222c6fb to c70e7f2 Compare December 9, 2025 19:17

dbochkov-flexcompute reviewed Dec 14, 2025

View reviewed changes

	@pd.validator("structures", always=True)
	@skip_if_fields_missing(["size", "center"])
	def _structures_not_at_edges(cls, val, values):
	"""Warn if any structures lie at the simulation boundaries."""

	if val is None:
	return val

	sim_box = Box(size=values.get("size"), center=values.get("center"))
	sim_bound_min, sim_bound_max = sim_box.bounds
	sim_bounds = list(sim_bound_min) + list(sim_bound_max)

	with log as consolidated_logger:
	for istruct, structure in enumerate(val):
	struct_bound_min, struct_bound_max = structure.geometry.bounds
	struct_bounds = list(struct_bound_min) + list(struct_bound_max)

	for sim_val, struct_val in zip(sim_bounds, struct_bounds):
	if anp.isclose(sim_val, struct_val):
	consolidated_logger.warning(
	f"Structure at 'structures[{istruct}]' has bounds that extend exactly "
	"to simulation edges. This can cause unexpected behavior. "
	"If intending to extend the structure to infinity along one dimension, "
	"use td.inf as a size variable instead to make this explicit.",
	custom_loc=["structures", istruct],
	)
	continue

	return val

feat(rf): FXC-1604 API for extending structures into pml #3026

Are you sure you want to change the base?

feat(rf): FXC-1604 API for extending structures into pml #3026

Uh oh!

Conversation

George-Guryev-flxcmp commented Nov 25, 2025 • edited by greptile-apps bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Greptile Overview

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Sequence Diagram

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Diff Coverage

Diff: origin/develop...HEAD, staged and unstaged changes

Summary

Uh oh!

daquinteroflex commented Nov 25, 2025

Uh oh!

weiliangjin2021 commented Nov 25, 2025

Uh oh!

Uh oh!

Uh oh!

daquinteroflex commented Nov 25, 2025

Uh oh!

George-Guryev-flxcmp commented Nov 25, 2025

Uh oh!

Uh oh!

Uh oh!

dbochkov-flexcompute left a comment

Choose a reason for hiding this comment

Uh oh!

dbochkov-flexcompute Dec 14, 2025

Choose a reason for hiding this comment

Uh oh!

dbochkov-flexcompute Dec 14, 2025

Choose a reason for hiding this comment

Uh oh!

dbochkov-flexcompute Dec 14, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

George-Guryev-flxcmp commented Nov 25, 2025 •

edited by greptile-apps bot

Loading

github-actions bot commented Nov 25, 2025 •

edited

Loading